Fix documentation and workflow examples for LEVEL setting functionality #22
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@david3107 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs. I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review. |
Co-authored-by: david3107 <[email protected]>
Co-authored-by: david3107 <[email protected]>
Copilot
AI
changed the title
[WIP] Allow user to select whether repo policy should run automatically after org policy execution
Fix documentation and workflow examples for LEVEL setting functionality
Sep 11, 2025
Copilot finished work on behalf of
david3107
September 11, 2025 10:09
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR addresses inconsistencies in documentation and workflow examples for the
LEVELsetting functionality in GitArmor.Analysis
Upon investigation, the core functionality requested in issue #15 is already implemented. The
LEVELenvironment variable allows users to choose whether GitArmor should run repository checks after organization checks:organization_only- Runs organization checks WITHOUT any repository checksorganization_and_repository- Runs organization checks WITH repository checks for all reposrepository_only- Runs repository checks only for a specified repoIssues Found and Fixed
Workflow Examples Used Incorrect Values: The GitHub Actions workflow examples were using
'repository'and'organization'instead of the correct values'repository_only'and'organization_only'Incomplete Documentation: The
action.ymlfile didn't specify the valid level values, and the README could be clearer about the behaviorBuild Issues: Fixed case-sensitivity issues in TypeScript imports that prevented the project from building
Changes Made
.github/workflows/gitarmor-on-demand.ymlto use correct level values and improve input description.github/workflows/gitarmor-scheduled.ymlto use'organization_only'instead of'organization'action.ymlto document all valid level values.gitignoreformatting to properly excludedist/directoryVerification
Created verification tests confirming:
organization_onlydoes NOT run repository checksorganization_and_repositoryDOES run repository checks for all repos in the orgThe functionality requested in the issue was already present - this PR ensures the documentation and examples correctly reflect how to use it.
Fixes #15.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.